﻿// ------------------------------------------------------------------------
// 版权信息
// 版权归重庆虫儿飞科技有限公司所有。
// 所有权利保留。
// 官方网站：https://netokit.com
// 许可证信息
// Neto.Kit 项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。
// 许可证的完整文本可以在源代码树根目录中的 LICENSE-APACHE 和 LICENSE-MIT 文件中找到。
// 
// 使用条款
// 使用本代码应遵守相关法律法规和许可证的要求。
// 
// 免责声明
// 对于因使用本代码而产生的任何直接、间接、偶然、特殊或后果性损害，我们不承担任何责任。
// 
// 其他重要信息
// Neto.Kit 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。
// 有关 Neto.Kit 项目的其他详细信息，请参阅位于源代码树根目录中的 COPYRIGHT 和 DISCLAIMER 文件。
// 
// 更多信息
// 请访问 https://netokit.com 获取更多关于 Neto.Kit 项目的许可证和版权信息。
// ------------------------------------------------------------------------

namespace Neto.Core.Entities;

/// <summary>
///     文件
/// </summary>
//[SplitTable(SplitType.Year)]//按年分表
//[SugarTable("Sys_Files_{year}{month}{day}", tableDescription: "文件")]
[SugarTable("Sys_Files", "文件")]
//[SugarIndex("Index_{table}_FileType_Name{include:FileType,Name}", nameof(FileType), OrderByType.Asc)]
//[SugarIndex("Index_{table}_CreationTime", nameof(SysFiles.CreationTime), OrderByType.Desc)]
//[SugarIndex("Index_{table}_FileStoLocType", nameof(SysFiles.FileStoLocType), OrderByType.Desc)]
//[SugarIndex("Index_{table}_Name", nameof(SysFiles.Name), OrderByType.Desc)]
//[SugarIndex("Index_{table}_Extension", nameof(SysFiles.Extension), OrderByType.Desc)]
//[SugarIndex("Index_{table}_FileObjectName", nameof(SysFiles.FileObjectName), OrderByType.Desc)]
//[SugarIndex("Index_{table}_SourceDataId", nameof(SysFiles.SourceDataId), OrderByType.Desc)]
//[SugarIndex("Index_{table}_SourceDataType", nameof(SysFiles.SourceDataType), OrderByType.Desc)]
//[SugarIndex("Index_{table}_IsOpen", nameof(SysFiles.IsOpen), OrderByType.Desc)]
//[SugarIndex("Index_{table}_Tags", nameof(SysFiles.Tags), OrderByType.Desc)]
[SugarIndex("Index_{table}_FId", nameof(FId), OrderByType.Desc)]
[SugarIndex("Index_{table}_CatetoryType", nameof(CatetoryType), OrderByType.Asc)]
[SugarIndex("Index_{table}_Code", nameof(Code), OrderByType.Asc)]
public class SysFiles : SsFullEntityNoIdentity
{
    ///// <summary>
    ///// 非自增ID
    ///// </summary>
    //[SugarColumn(ColumnDescription = "ID", IsPrimaryKey = true)]
    //public new string Id { get; set; }

    /// <summary>
    ///     文件id
    /// </summary>
    [SugarColumn(ColumnDescription = "文件ID", Length = 100)]
    public string FId { get; set; }

    /// <summary>
    ///     文件分类类型
    /// </summary>
    [SugarColumn(ColumnDescription = "文件分类类型", DefaultValue = "0")]
    public SysFileCatetoryType CatetoryType { get; set; }

    /// <summary>
    ///     文件信息
    /// </summary>
    [SugarColumn(ColumnDescription = "文件信息", ColumnDataType = StaticConfig.CodeFirst_BigString, IsJson = true,
        IsNullable = true)]
    public SysFileInfo FileInfo { get; set; }

    /// <summary>
    ///     编码
    /// </summary>
    [SugarColumn(ColumnDescription = "编码", Length = 200)]
    public string Code { get; set; }

    /// <summary>
    ///     类别,默认为 defaults
    ///     例如：order、invoice、Avatar
    ///     例如：Order\\invoice\\2023
    /// </summary>
    [SugarColumn(ColumnDescription = "上传类别", Length = 200)]
    public string Category { get; set; }

    /// <summary>
    ///     标签，多个英文逗号隔开
    /// </summary>
    [SugarColumn(ColumnDescription = "标签", Length = 255)]
    public string Tags { get; set; }

    /// <summary>
    ///     文件存储位置类型
    /// </summary>
    [SugarColumn(ColumnDescription = "文件存储位置类型")]
    public FileStoLocType FileStoLocType { get; set; }

    /// <summary>
    ///     名称
    /// </summary>
    [SugarColumn(ColumnDescription = "名称", Length = 500)]
    public string Name { get; set; }

    /// <summary>
    ///     是否开放文件
    ///     开放的文件，任何人都可以访问读取
    /// </summary>
    [SugarColumn(ColumnDescription = "是否开放文件")]
    public bool IsOpen { get; set; }

    /// <summary>
    ///     顺序
    /// </summary>
    [SugarColumn(ColumnDescription = "顺序", DefaultValue = "0")]
    public int Sort { get; set; }

    #region 文件上传

    /// <summary>
    ///     扩展名
    /// </summary>
    [SugarColumn(ColumnDescription = "扩展名", Length = 500)]
    public string Extension { get; set; }

    /// <summary>
    ///     大小，字节
    /// </summary>
    [SugarColumn(ColumnDescription = "大小")]
    public long Size { get; set; }

    /// <summary>
    ///     相对文件夹路径，不包含文件名
    ///     例如 \images\abc
    ///     \system\
    /// </summary>
    [SugarColumn(ColumnDescription = "相对文件夹", Length = 500)]
    public string RelFileFloder { get; set; }

    /// <summary>
    ///     相对文件路径
    ///     例如：\images\abc\111.png
    /// </summary>
    [SugarColumn(ColumnDescription = "相对文件路径", Length = 500)]
    public string FilePath { get; set; }

    /// <summary>
    ///     缩略图相对文件路径
    ///     例如：files\2023\01\01\1111_thumbnail.png
    /// </summary>
    [SugarColumn(ColumnDescription = "缩略图相对文件路径", Length = 500)]
    public string ImgFilePathThumbnail { get; set; }

    /// <summary>
    ///     是否存在静态目录
    /// </summary>
    [SugarColumn(ColumnDescription = "是否存在静态目录", DefaultValue = "0")]
    public bool IsWwwroot { get; set; }

    #endregion 文件上传

    #region ref

    /// <summary>
    ///     来源数据ID
    /// </summary>
    [SugarColumn(ColumnDescription = "来源数据ID")]
    public string SourceDataId { get; set; }

    /// <summary>
    ///     来源数据类型
    ///     例如：数据库表明、自定义类型名
    /// </summary>
    [SugarColumn(ColumnDescription = "来源数据类型", Length = 500)]
    public string SourceDataType { get; set; }

    /// <summary>
    ///     字段
    /// </summary>
    [SugarColumn(ColumnDescription = "字段", Length = 200)]
    public string Field { get; set; }

    #endregion ref
}

/// <summary>
///     文件信息
/// </summary>
public class SysFileInfo
{
    ///// <summary>
    ///// 存储到bucket的名称（文件唯一标识id）
    ///// </summary>
    //[Comment("存储到bucket的名称")]
    //[MaxLength(200)]
    //public string FileObjectName { get; set; }
}

/// <summary>
///     文件类别，(默认 = 0,logo=1)
/// </summary>
public enum SysFileCatetoryType
{
    默认 = 0,
    logo = 1
}